<div class="well well-small api-menu">
	<?php $this->widget('ApiMenuWidget'); ?>
</div>
<?php
$this->beginWidget('bootstrap.widgets.TbBox', array(
	'title' => false,
	'htmlOptions' => array('class' => 'api-doc'),
));
?>

<h2>登录授权</h2>
<p>提交用户名和密码换取 <code>access_token</code>，其他 API 中均需用到。</p>

<h4>URL</h4>
<p><code><?php echo $this->createApiUrl(null, 'https'); ?></code></p>

<h4>请求、响应方式</h4>
<p>POST 请求，JSON 响应。</p>

<h4>请求参数</h4>
<table class="table table-bordered">
	<tr><th>名称</th><th>必填</th><th>类型/范围</th><th>说明</th></tr>
	<tr>
		<td>username</td>
		<td>true</td>
		<td>string</td>
		<td>登录用户名。</td>
	</tr>
	<tr>
		<td>password</td>
		<td>true</td>
		<td>string</td>
		<td>登录密码。</td>
	</tr>
</table>

<h4>注意事项</h4>
<p>无</p>

<h4>成功返回</h4>
<p>
	<pre>{ "result":true, "access_token":"7eaa1129ea6ef53f31b8f8c78727d012", "expires_in":86400 }</pre>
</p>

<h4>结果说明</h4>
<table class="table table-bordered">
	<tr><th>名称</th><th>含义说明</th></tr>
	<tr>
		<td>result</td>
		<td>操作是否成功。</td>
	</tr>
	<tr>
		<td>access_token</td>
		<td>身份授权 token，用于访问其他 API。</td>
	</tr>
	<tr>
		<td>expires_in</td>
		<td>Token 的有效期限（单位：秒）。</td>
	</tr>
</table>

<h4>出错情况</h4>
<p>出错时 HTTP 的响应状态码为 200 以外的其它值，含义如下：</p>
<table class="table table-bordered">
	<tr><th>HTTP 状态</th><th>出错说明</th></tr>
	<tr>
		<td>400</td>
		<td>提供的密码不匹配。</td>
	</tr>	
	<tr>
		<td>404</td>
		<td>提供的用户名不存在。</td>
	</tr>
	<tr>
		<td>500</td>
		<td>内部错误，通常是程序或数据库出错。</td>		
	</tr>
</table>

<?php $this->endWidget();?>
